home *** CD-ROM | disk | FTP | other *** search
/ AMIGA-CD 2 / Amiga-CD - Volume 2.iso / ungepackte_daten / 1992 / 11 / 02 / makecat / makecat.doc < prev    next >
Encoding:
Text File  |  1995-06-01  |  15.3 KB  |  364 lines
  1.  
  2.                  Dokumentation zu MakeCat Version 38.05
  3.                ==========================================
  4.  
  5.            geschrieben von Alexander Kochann und Oliver Reiff
  6.                               (5.10.1992)
  7.  
  8. -------------------------------------------------------------------------------
  9. -------------------------------------------------------------------------------
  10.  
  11. Gleich vorweg:
  12.  Auch wir sind nicht (ganz) perfekt !
  13.  Sollten
  14.   - irgendwelche Fehler auftreten,
  15.   - Sie irgenwelche Fragen haben,
  16.   - Sie uns Ihre Meinung zu MakeCat sagen wollen
  17.   - oder sogar Verbesserungsvorschläge haben,
  18.  melden Sie sich bitte einfach bei uns:
  19.  
  20.  PALADIN SOFTWARE
  21.  Jakob-Bernhard-Straße 8
  22.  D-W-6903 Dilsberg
  23.  Germany
  24.  
  25.  Tel.: 06223 / 74630
  26.  Fax : 06221 / 166071
  27.  
  28.  Wir freuen uns über jeden Vorschlag oder gefundenen Fehler.
  29.  
  30. -------------------------------------------------------------------------------
  31. -------------------------------------------------------------------------------
  32.  
  33. Leider ist der erste Fehler bereits passiert:
  34.  
  35. Der Artikel "Man spricht Deutsch" des AMIGA-Magazins Ausgabe 11/92,
  36. in dem das Programm MakeCat beschrieben wird, bezieht sich auf eine
  37. ältere Version von MakeCat. Die Anweisung "DATE" wurde aus 
  38. Kompatibilitätsgründen zum MaxonASM in "CATDATE" umbenannt.
  39. Ein weiterer Fehler betrifft die aufgeführten CT-Files. Der '\' am Ende
  40. einer Zeile bedeutet nämlich NUR bei der Definition von Zeichenketten,
  41. daß die nächste Zeile die Fortsetzung derselben aufzufassen ist. Es gilt
  42. NICHT bei der Definition der Version, des Headers usw.
  43. Ein weiterer Fehler ist, daß beim Umwandeln des abgedruckten Quellcodes in
  44. Kataloge maximal zwei Kataloge angelegt werden und NICHT wie angegeben
  45. deren drei.
  46. Eine Defaultversion wird auch nicht mehr gesetzt.
  47. Die Sprachkennung US wird nicht mehr akzeptiert.
  48. Und der letzte inhaltliche Fehler: Die Adressen der Strings aus den
  49. Katalogen bekommen Sie selbstverständlich NICHT mit GetLocaleStr(),
  50. sondern mit GetCatalogStr().
  51. Last but not least wurde noch vergessen das Assign 'LD:' zu erklären.
  52. Es steht - schlicht und ergreifend - für 'LocaleData'.
  53.  
  54. -------------------------------------------------------------------------------
  55. -------------------------------------------------------------------------------
  56.  
  57.  Außerdem besteht die Möglichkeit bei uns als "Language-Developer"
  58.  mitzuwirken. Dazu übersetzen Sie am besten einen oder mehrere
  59.  Kataloge in eine Sprache, die MakeCat noch nicht unterstützt und
  60.  schicken uns diesen zu. Wenn Sie darüberhinaus auch an einer
  61.  längeren Zusammenarbeit interessiert sind, schicken wir Ihnen
  62.  kurz vor der Veröffentlichung eines Updates eine Kopie, von der 
  63.  Sie wiederum eine Übersetzung anfertigen. So machen Sie MakeCat
  64.  auch denen zugänglich, die Ihre Sprache sprechen und bekommen
  65.  zwar kein Geld, aber immer die neueste Version von MakeCat. 
  66.  
  67. -------------------------------------------------------------------------------
  68. -------------------------------------------------------------------------------
  69.  
  70. Zu MakeCat gehören folgende Dateien:
  71.            MakeCat               - am besten ins Tools-Verzeichnis
  72.            MakeCat.info          - natürlich zu MakeCat
  73.            MakeCat.catalog       - die deutsche Katalogdatei gehört in
  74.                                    LOCALE:Catalogs/deutsch; entsprechendes
  75.                                    gilt für die übrigen Kataloge. 
  76.                                    ( wer weitere Kataloge erstellt, möchte sie
  77.                                      uns bitte zuschicken s.o.)
  78.            MakeCat_D.doc         - zum einmaligen Lesen oder sonstwohin
  79.            MakeCat_D.doc.info    - ein Icon zum Starten von WatchIt
  80.            MakeCat.cd            - Hier stehen alle orginalen Texte, da in den
  81.                                    Katalogen nur manche übersetzt sind. Am
  82.                                    besten nach LD:
  83.            paladin.library       - natürlich nach LIBS:
  84.            paladin.catalog       - siehe MakeCat.catalog, jedoch in allen
  85.                                    Sprachen, so gut wir sie eben übersetzen
  86.                                    konnten.... (Verbesserung und Fehler s.o.)
  87.            Paladin_D.doc         - Deutsche Dokumentation zur Paladin-Library
  88.            Paladin_D.doc.info    - ein Icon zum Starten von WatchIt
  89.            Paladin_lib.fd        - FD-File zur Paladin-Library, nach FD:
  90.  
  91.            Diese Dateien können Sie auch automatisch mit MakeCat_Install
  92.            auf Ihre Festplatte installieren. Dazu benötigen Sie das Programm
  93.            'Installer' von der Diskette 'Install2.1' oder 'Install3.0' im
  94.            'C:'-Verzeichnis Ihrer Festplatte (Diskette...)
  95.  
  96.            Außerdem benötigt MakeCat OS2.1/3.0 (asl- und locale.library)
  97.            und die paladin.library 38.101 !
  98.     
  99. -------------------------------------------------------------------------------
  100. -------------------------------------------------------------------------------
  101.  
  102. Hier zeigen wir Ihnen, wie sie die MakeCat-Kataloge leicht verändern
  103. und für andere Sprache anpassen können:
  104.  
  105. - Stellen Sie in MakeCat ein:
  106.   "Ausgabe    C-Source    Ram:MakeCat.c"
  107.   "Eingabe       CD       MakeCat.cd"
  108.   "Eingabe    Katalog     sprache/MakeCat.catalog"
  109.  
  110. - Starten Sie die Konvertierung.
  111.  
  112. - In der Datei "Ram:MakeCat.c" stehen nun die Orginal-Texte und die
  113.   Übersetzungen aus dem Katalog. Sie können jetzt in Ruhe Ergänzungen
  114.   und Veränderungen vornehmen.
  115.  
  116. - Stellen Sie wieder in MakeCat ein ( vergessen sie nicht die gewünschte
  117.   Sprache ebenfalls anzugeben, die Option 'Kataloge freigeben' einzustellen
  118.   und den MakeCat.catalog ins richtige Verzeichnis zu schreiben ):
  119.   "Eingabe    C-Source    Ram:MakeCat.c"
  120.   "Ausgabe    Katalog     sprache/MakeCat.catalog"
  121.  
  122. - Starten Sie die Konvertierung.
  123.  
  124. Nun steht der neue Katalog mit Ihren Veränderungen zur Verfügung.
  125. Wenn sie somit einen vollständig Katalog für eine Sprache erzeugt
  126. haben, schicken Sie ihn uns bitte zu (s.o)
  127.  
  128.                                WICHTIG !
  129.  
  130. Damit Kataloge nach Änderungen vom System angenommen werden, muss man
  131. entweder den Befehl 'avail flush' eingeben oder in MakeCat die Option
  132. 'Kataloge freigeben' aktiviert haben. Dabei dürfen die alten Kataloge
  133. von keinem Progamm mehr benutzt werden !
  134.  
  135. -------------------------------------------------------------------------------
  136. -------------------------------------------------------------------------------
  137.  
  138. MakeCat wurde als Ersatz für das CLI-Programm "CatComp" geschrieben,
  139. das sich auf der Developers2.1-Diskette befindet. Es dient vor allem
  140. dazu, die für das Locale-System so wichtigen Katalogdateien zu 
  141. erzeugen. Neben dem Katalog-Format kennt MakeCat aber noch 6 andere
  142. Formate, die sowohl gelesen als auch geschrieben werden können.
  143.  
  144. Die Bedienung von MakeCat ist durch die Benutzeroberfläche recht
  145. einfach. Wählen Sie Ihre Ein- und Ausgabedatei(en) und anschließend
  146. "Konvertieren". Die Namen der Dateien können Sie in den StringGadgets
  147. ändern oder mit Hilfe eines FileRequesters, der nach einem Klick auf
  148. die mittlere Gadgetspalte erscheint.
  149.  
  150. Wenn Sie als CT-Datei Demo_D.ct angeben, wird MakeCat auch auf andere
  151. CT-Dateien gleichen Namens, wie Demo_DK.ct, zurückzugreifen, wenn Sie
  152. in der obersten Gadgetleiste mit den Sprachkürzeln andere Sprachen 
  153. aktivieren. Ebenso verfährt MakeCat beim Zugriff auf die Kataloge.
  154.  
  155. Alle Einstellungen können mit Hilfe des Einstellungs-Menus gespeichert
  156. werden. Wählen Sie dazu die jeweiligen Punkte an. Auf diese Weise teilen
  157. sie MakeCat mit, welche Einstellungen gespeichert werden sollen und
  158. welche nicht. Wenn sie 'Einstellungen setzen' aktivieren, so merkt sich
  159. der Amiga Ihre Einstellungen beim Programmende. Er speichert sie aber
  160. nicht ab !
  161. Besonders wichtig kann die Einstellung 'Kataloge freigeben' werden.
  162. Wenn Sie Kataloge anlegen, und diese Option aktiviert haben, so
  163. werden alle Daten im Speicher, die nicht benutzt werden, freigegeben.
  164. Also, z.B. unbenutze Kataloge oder Libraries (das gleiche passiert bei
  165. 'avail flush'). Dies ist beim Programmieren sehr nützlich, da sich
  166. die Texte im Programm (und somit die Kataloge) schnell mal ändern können.
  167. Wenn der alte Katalog nicht mehr benutzt wird, wird er beim Anlegen des
  168. neuen automatisch aus dem Speicher entfernt.
  169.  
  170. -------------------------------------------------------------------------------
  171. -------------------------------------------------------------------------------
  172.  
  173. Doch nun zu den Formaten im einzelnen:
  174.  
  175.   ASS-Source:   ein Assemblerquelltext oder der Localeteil davon
  176.  
  177.            Gedacht für Programmierer, die mit dem Macro LocLea und der
  178.            Routine GetString arbeiten.
  179.     Diese Routine benutzt Nullbytes als Endkennung von Strings !
  180.     In Katalogdateien dürfen aber auch Nullbytes in Strings vor-
  181.     kommen, deshalb kann es zu Kompatibilitätsproblemen kommen,
  182.     wenn Sie Kataloge in Assembler und wieder zurück übersetzen!
  183.     Benutzen Sie lieber den C-Source zum "Editieren" von Kata-
  184.     logen. Ein weiteres Problem stellen die Punkte in Labelnamen
  185.     dar, die CatComp in CD- und CT-Dateien NICHT akzeptiert !
  186.     Verwenden Sie also keine Punkte, wenn Sie außer Katalogen
  187.     auch noch CD- oder CT-Dateien erstellen wollen.
  188.  
  189.            Zwischen den Labels LOCALE_START und LOCALE_END könne wie 
  190.            in Assembler üblich Zeichenketten definiert werden:
  191.               Bsp:   Name       dc.b        'Hallo Ihr',10,"xxx",$45,0
  192.  
  193.            Außerdem können in Kommentarzeilen oder Macros die Über-
  194.            setzungen definiert werden, die im assemblierten Programm
  195.            NICHT auftauchen !!!
  196.               Bsp:             D 'Das ist deutsch !',10
  197.                          * D 'Und das auch',0
  198.                              * F "C'est français",0
  199.  
  200.            Außerdem können ebenso in Kommentarzeilen oder Macros
  201.            folgende Anweisungen erteilt werden:
  202.                    CATALOG   name    - setzt den Namen des Katalogs
  203.                    VERSION   xx.xx   - setzt die Versionsnummer des Katalogs
  204.                    CATDATE   x.x.x   - setzt das Erstellungsdatum
  205.                    LEN       min,max - setzt minimale und maximale Länge
  206.                                        der Übersetzungstexte
  207.                    LEN       max     - setzt NUR die maximale Länge !
  208.  
  209.            Benutzt man Macros (wegen der Übersicht!), so sollten sie wie
  210.            folgt definiert werden:
  211.              Beispiel für die deutsche Übersetzung:
  212.                         D      macro
  213.                                endm
  214.                                  
  215.            Wichtig ist, daß alle Strings mit einem Nullbyte enden müssen
  216.            und keine anderen Anweisungen zwischen den Labeln stehen.
  217.  
  218.  
  219.  
  220.   C-Source:    ein C-Quelltext oder der Locale-Teil davon
  221.  
  222.            Zwischen den Zeilen
  223.            '#define LOCALE_START' und
  224.            '#define LOCALE_END' können die LocText-Strukturen definiert
  225.            werden.
  226.               Bsp:    struct LocText text1={1,"String 1"};
  227.  
  228.            Außerdem können in Kommentarfeldern Übersetzungen definiert werden,
  229.            die im kompilierten Programm NICHT auftauchen !!!
  230.               Bsp:  /*
  231.                               D  "Das ist deutsch !"
  232.                               F  "C'est français"
  233.                           */
  234.  
  235.            Mehrzeilige Übersetzungen können so angegeben werden:
  236.                          /*
  237.                               D     "Zeile 1 und /"
  238.                                     "Zeile 2"
  239.                          */
  240.  
  241.            Außerdem können ebenso in Kommentarfeldern folgende Anweisungen
  242.            erteilt werden:
  243.                     CATALOG  name    - setzt den Namen des Katalogs
  244.                     VERSION  xx.xx   - setzt die Versionsnummer des Katalogs
  245.                     CATDATE  x.x.x   - setzt das Erstellungsdatum
  246.                     LEN      min,max - setzt minimale und maximale Länge
  247.                                        der Überetzungstexte
  248.                     LEN      max     - setzt NUR die maximale Länge !
  249.  
  250.  
  251.  
  252.   ASM:   ein Assemblerinclude
  253.  
  254.            Gedacht für Assembler-Programmierer, die mit AppStrings arbeiten.
  255.  
  256.            Diese Datei sollte eigentlich nur geschrieben werden.
  257.            In ihr wird die AppString-Struktur definiert, sowie die Nummern
  258.            und Originaltexte.
  259.            Nähere Informationen siehe Doc-File zu CatComp !
  260.  
  261.  
  262.  
  263.   C:     ein C-Include
  264.  
  265.            Gedacht für C-Programmierer, die mit AppStrings arbeiten.
  266.  
  267.            Diese Datei sollte eigentlich nur geschrieben werden.
  268.            In ihr wird die AppString-Struktur definiert, sowie die Nummern
  269.            und Originaltexte.
  270.            Nähere Informationen siehe Doc-File zu CatComp !
  271.  
  272.  
  273.  
  274.  
  275.   CD:    eine 'Catalog Description'-Datei
  276.              
  277.            Sie enthält die Nummern, Kennungen und Originaltexte, sowie die
  278.            Längenbegrenzungen für die Übersetzungen.
  279.  
  280.              Bsp:         Text1_STR (22/7/80)
  281.                           Hallo Leute, ein deutscher String !
  282.  
  283.            Das Beispiel weist dem String Nr. 22 die Kennung Text1_STR und den
  284.            Text in der zweiten Zeile zu. Die minimale Länge der Übersetzungen
  285.            sollte 7, die maximale Länge 80 betragen.
  286.  
  287.            Mit '#header name' kann man den Namen eines zu erzeugenden Includes
  288.            festlegen.
  289.            Kommentarzeilen beginnen mit ';'.
  290.            Sonderzeichen siehe Tabelle 1.
  291.            Nähere Informationen siehe Doc-File zu CatComp !
  292.  
  293.  
  294.  
  295.  
  296.   CT:    eine 'Catalog Translation'-Datei
  297.  
  298.            Sie enthält die Übersetzungen in einer bestimmten Sprache.
  299.  
  300.                Bsp:     Text1_STR
  301.                         C'est français !
  302.  
  303.            Der sog. Header enthät außerdem weitere Informationen:
  304.  
  305.                ## version $VER: name.catalog ver.rev (10.09.92)
  306.                ## codeset 0
  307.                ## language français
  308.  
  309.            Kommentarzeilen beginnen mit ';'.
  310.            Sonderzeichen siehe Tabelle 1.
  311.            Sie sollte im Verzeichnis 'LD:' (zu assignen!) aufbewahrt
  312.            werden. An den eigentlichen Namen sollte ein Sprachkürzel
  313.            (siehe Tabelle 2) und '.ct' angehägt werden.
  314.                Bsp:        LD:demo_D.ct
  315.            Nähere Informationen siehe Doc-File zu CatComp !
  316.  
  317.  
  318.  
  319.  
  320.   Katalog: eine Katalog-Datei
  321.  
  322.            Sie ist eine IFF-Datei, die nicht per Hand geändert werden
  323.            sollte.
  324.            Das fertige Programm benötigt sie zum Öffnen mit OpenCatalogA().
  325.            Dabei werden sie im Verzeichnis LOCALE:Catalogs/<sprache>,
  326.            bzw. einem Unterverzeichnis gesucht !
  327.  
  328. -------------------------------------------------------------------------------
  329. -------------------------------------------------------------------------------
  330.  
  331. Tabelle 1: Sonderzeichen in CD- und CT-Dateien
  332.  
  333.     \a     fügt ASCII-7 (BEEP) ein
  334.     \b     fügt ASCII-8 (BACKSPACE) ein
  335.     \c     fügt ASCII-155 (CSI) ein
  336.     \e     fügt ASCII-27 (ESC) ein
  337.     \f     fügt ASCII-12 (Formfeed) ein
  338.     \n     fügt ASCII-10 (Linefeed) ein
  339.     \r     fügt ASCII-13 (Return) ein
  340.     \t     fügt ASCII-9 (Tabulator) ein
  341.     \v     fügt ASCII-11 (Vertikaler Tabulator) ein
  342.     \xNN   fügt ASCII-NN ein, wobei NN eine Hexadezimalzahl ist
  343.     \NNN   fügt ASCII-NNN ein, wobei NNN eine Oktalzahl ist
  344.     \\a     fügt '\a' ein (gilt auch für \\b, \\c, \\d ...)
  345.     \      am Zeilenende führt dazu, daß die nächste Zeile als
  346.            Fortsetzung dieser Zeile aufgefaßt wird
  347.  
  348. -------------------------------------------------------------------------------
  349. -------------------------------------------------------------------------------
  350.  
  351. Tabelle 2 : Alle Sprachkürzel 
  352.  
  353.     D      deutsch
  354.     DK     dänisch
  355.     E      spanisch
  356.     F      französisch
  357.     GB     englisch
  358.     I      italienisch
  359.     N      norwegisch
  360.     NL     holländisch
  361.     P      portugiesisch
  362.     S      schwedisch
  363.  
  364.